Add --suites filter to generate_reference_results#728
Conversation
MakisH
left a comment
There was a problem hiding this comment.
Thanks for contributing! This is useful, especially since I would now restructure our test.yaml based on more granular test cases (#767).
I tested it locally, and it works as expected. Just one comment on an error message, which should be easy to fix (I can also just fix it directly).
I am also requesting a Copilot review mostly out of curiosity.
There was a problem hiding this comment.
Pull request overview
Adds an optional test-suite filter to the reference-results generation tooling and workflows, so maintainers can regenerate reference results for only selected suites (instead of always rebuilding all archives).
Changes:
- Added
--suites(comma-separated) totools/tests/generate_reference_results.pyto filter which suites are processed. - Extended the reusable workflow and the manual workflow-dispatch UI to accept an optional
suitesinput and forward it to the script. - Updated the workflow’s staging logic to avoid broadly re-adding all reference result archives when a filter is used.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| tools/tests/generate_reference_results.py | Introduces --suites filtering logic for selecting a subset of test suites. |
| .github/workflows/generate_reference_results_workflow.yml | Adds suites input, passes it to the generator, and changes staging behavior for filtered runs. |
| .github/workflows/generate_reference_results_manual.yml | Adds a suites input to the manual trigger and forwards it to the reusable workflow. |
| changelog-entries/711.md | Documents the new optional suites filter for reference result generation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Suggested by Copilot
As suggested by Copilot
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Closes #711
Changes
tools/tests/generate_reference_results.py— added--suitesargument (comma-separated, optional) to filter which test suites to generate reference results for. When not provided, all suites run (backward compatible).generate_reference_results_workflow.yml— added optionalsuitesinput. When provided, passes--suitesto the script and uses selectivegit add --updateto only commit modified files. When empty, behavior is unchanged.generate_reference_results_manual.yml— addedsuitesinput field for the manual trigger UI.Testing
1. full docker test passed for

--suitesfilteronly 3 elastic tube tests ran not all 10
2. error handling for invalid suite name

3. backward compatible default behavior (no

--suites)4.

--helpshows a new argumentChecklist:
changelog-entries/<711>.md.